home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2007 September / PCWSEP07.iso / Software / Linux / Linux Mint 3.0 Light / LinuxMint-3.0-Light.iso / casper / filesystem.squashfs / usr / share / doc / doc-base / install-docs.html < prev    next >
Encoding:
Extensible Markup Language  |  2007-02-22  |  4.1 KB  |  126 lines
  1. <?xml version="1.0" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <title>install-docs reference</title>
  6. <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  7. <link rev="made" href="mailto:root@localhost" />
  8. </head>
  9.  
  10. <body style="background-color: white">
  11.  
  12. <p><a name="__index__"></a></p>
  13. <!-- INDEX BEGIN -->
  14.  
  15. <ul>
  16.  
  17.     <li><a href="#name">NAME</a></li>
  18.     <li><a href="#synopsis">SYNOPSIS</a></li>
  19.     <li><a href="#description">DESCRIPTION</a></li>
  20.     <li><a href="#options">OPTIONS</a></li>
  21.     <li><a href="#bugs">BUGS</a></li>
  22.     <li><a href="#see_also">SEE ALSO</a></li>
  23.     <li><a href="#author">AUTHOR</a></li>
  24. </ul>
  25. <!-- INDEX END -->
  26.  
  27. <hr />
  28. <p>
  29. </p>
  30. <h1><a name="name">NAME</a></h1>
  31. <p>install-docs - manage online Debian documentation</p>
  32. <p>
  33. </p>
  34. <hr />
  35. <h1><a name="synopsis">SYNOPSIS</a></h1>
  36. <pre>
  37.  install-docs [ -v, --verbose ]
  38.               [ --no-update-menus ]
  39.               -i --install | 
  40.               -r --remove  |
  41.               -s --status  |
  42.               -L --listfiles
  43.                 <doc-id | file></pre>
  44. <p>
  45. </p>
  46. <hr />
  47. <h1><a name="description">DESCRIPTION</a></h1>
  48. <p><strong>install-docs</strong> is a tool allow Debian package maintainers to register
  49. documentation to various documentation systems.  It currently supports
  50. <strong>dhelp</strong> and <strong>dwww</strong>.</p>
  51. <p>This manual page provides a quick synopsis of <strong>install-docs</strong> usage.
  52. Full documentation can be found in the documentation, including a
  53. description of the control file syntax and grammar.</p>
  54. <p>
  55. </p>
  56. <hr />
  57. <h1><a name="options">OPTIONS</a></h1>
  58. <dl>
  59. <dt><strong><a name="item__2dv__7c__2d_2dverbose"><strong>-v</strong> | <strong>--verbose</strong></a></strong>
  60.  
  61. <dd>
  62. <p>Operate verbosely.</p>
  63. </dd>
  64. </li>
  65. <dt><strong><a name="item__2d_2dno_2dupdate_2dmenus"><strong>--no-update-menus</strong></a></strong>
  66.  
  67. <dd>
  68. <p>Inhibit running <em>update-menus(1)</em>, used for the <em>dwww(8)</em> update program.</p>
  69. </dd>
  70. </li>
  71. <dt><strong><a name="item__2di_file__7c__2d_2dinstall_file"><strong>-i</strong> <em>file</em> | <strong>--install</strong> <em>file</em></a></strong>
  72.  
  73. <dd>
  74. <p>Install the documentation described by the control file <em>file</em>.</p>
  75. </dd>
  76. </li>
  77. <dt><strong><a name="item__2dr_docid__7c__2d_2dremove_docid"><strong>-r</strong> <em>docid</em> | <strong>--remove</strong> <em>docid</em></a></strong>
  78.  
  79. <dd>
  80. <p>Remove the documentation identified by the document identifier
  81. <em>docid</em>.  Document identifiers are tags which are set in the control
  82. file, and usually correspond to the package name.</p>
  83. </dd>
  84. </li>
  85. <dt><strong><a name="item__2ds_docid__7c__2d_2dstatus_docid"><strong>-s</strong> <em>docid</em> | <strong>--status</strong> <em>docid</em></a></strong>
  86.  
  87. <dd>
  88. <p>Display the status of the document identifier <em>docid</em>.</p>
  89. </dd>
  90. </li>
  91. <dt><strong><a name="item__2dl_docid__7c__2d_2dlistfiles_docid"><strong>-L</strong> <em>docid</em> | <strong>--listfiles</strong> <em>docid</em></a></strong>
  92.  
  93. <dd>
  94. <p>List the files associated with the document identifier <em>docid</em>.</p>
  95. </dd>
  96. </li>
  97. </dl>
  98. <p>
  99. </p>
  100. <hr />
  101. <h1><a name="bugs">BUGS</a></h1>
  102. <p>None known, but a much more robust system is being planned as the next
  103. generation of doc-base.</p>
  104. <p>
  105. </p>
  106. <hr />
  107. <h1><a name="see_also">SEE ALSO</a></h1>
  108. <p>dwww(8), Debian doc-base Manual
  109. <em>/usr/share/doc/doc-base/doc-base.html/index.html</em>, dhelp Manual
  110. <em>/usr/share/doc/dhelp/dhelp.html</em></p>
  111. <p>
  112. </p>
  113. <hr />
  114. <h1><a name="author">AUTHOR</a></h1>
  115. <p>This program was originally written by Christian Schwarz
  116. <<a href="mailto:schwarz@debian.org">schwarz@debian.org</a>>, for the Debian GNU/Linux system.  Adam Di Carlo
  117. <<a href="mailto:aph@debian.org">aph@debian.org</a>> is currently maintaining and extending it.</p>
  118. <p>This software was meant to be for the benefit of the entire Debian
  119. user and developer community.  If you are interested in being involved
  120. with this software, please join the mailing list
  121. <<a href="mailto:debian-doc@lists.debian.org">debian-doc@lists.debian.org</a>>.</p>
  122.  
  123. </body>
  124.  
  125. </html>
  126.